complete docstrings for ContractFunction and reorder contract classes
#2960
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pacrob
force-pushed
the
update-contract-docstrings
branch
from
e04ca99
to
1d960bc
Compare
kclowes
approved these changes
May 22, 2023
| @@ -125,6 +125,132 @@ | |||
| from .contract import ContractFunction # noqa: F401 | |||
|
|
|||
|
|
|||
| class BaseContractEvents: | |||
There was a problem hiding this comment.
I think it would make sense for this to be close in location to the BaseContractEvent class, what do you think about that? And similarly, have BaseContractFunctions and BaseContractFunction close as well.
There was a problem hiding this comment.
Yup, I went back and forth on that - ContractFunctions and ContractEvents are the only ones that needed to be on top for dependency ordering, so I went with just floating them up, but no issue with pulling Function and Event up too. Will do.
pacrob
force-pushed
the
update-contract-docstrings
branch
from
6f4c753
to
d2091bb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was wrong?
ContractFunctionandAsyncContractFunctionwere missing params in their docstrings.Contract files have similarly named classes, but all were in different order.
How was it fixed?
Completed docstrings for above classes and updated associated docs to match.
Ordered related classes similarly across the 3 contract files.
Todo:
Cute Animal Picture